Installer-StyleGuide

[Die Übersetzung und die Verwendung des Originaltextes durch den AmZeiger wurde durch Amiga Int., Inc. autorisiert; d. Chefred.]

Eigene Anmerkungen sind durch geschweifte Klammern { } gekennzeichnet.

Ein Installer-Script für eine bestimmte Anwendung zu erstellen, ist mit Hilfe des Installers V43.2 {V43.3} recht einfach. Aber um eine wirklich großartige Installation durchzuführen, halten Sie sich bitte an die folgenden Regeln...

• Der Installer hält mit der V43 ein paar neue Funktionen bereit, wie bessere Rückgabewerte für gewisse Statements und proportionale GUI-Darstellung für Auswahl-Screens. Die mindest-Versionsnummern {für die einzelnen Funktionen} sind in den entsprechenden Beschreibungen vermerkt. Bitte überprüfen Sie die Variable `@installer-version', bevor Sie diese neuen Funktionen verwenden.

  Diese Variable wird bei alten Versionen des Installers {in denen sie noch nicht angeboten wurde}, wie z.B. der V1.24, den Wert 0 annehmen, es ist also sicher und leicht, sie zu überprüfen. Bitte prüfen Sie nicht exakt auf Gleichheit, sondern wie bei Libraries auf eine minimale Revisions-Nummer.

  
  
  

• Beginnend mit dem Installer V42 wurden einige Richtlinien für die Namensgebungen festgelegt. Bitte halten Sie sich daran, da es sonst zu Problemen mit zukünftigen Installer-Versionen kommen kann.

  Benutzen Sie nicht das `@'-Zeichen in Ihren eigenen Variablennamen. Dieses Zeichen kennzeichnet {vom Installer angebotene} vordefinierte Variablen}. Benutzen Sie aber bitte ein Prefix für Ihre Variablen, wie `#' {wird von den meisten auch so gehandhabt}, und benennen Sie ihre Prozeduren sinnvoll und unter Verwendung des Prefixes `P_'.
  Namen ohne ein Prefix {oder mit einem `@'} könnten sich mit zukünftigen Erweiterungen des Installers überlappen.
  
  
• Bauen Sie immer immer immer { ;-) } auch sinnvolle Hilfstexte in ihre Installerscripts ein. {Eine der Stärken des Installers ist das Angebot einer stets griffbereiten Online-Hilfe. Es wäre nicht fein, dem User dort leere Seiten zu präsentieren. Damit man nicht jedesmal die grundlegende Bedienung des Installers erläutern muß, bietet dieser auch in vordefinierten Variablen bereits Hilfstexte dazu an.}
  
  
• Installieren Sie Teile Ihrer Anwendungen nur dann in Standard-OS- Verzeichnisse wie `DEVS:', `SYS:', oder `FONTS:', wenn es unbedingt nötig ist. Viele Leute versuchen ihre Applikationen separat vom Betriebssystem zu halten, um Updates {oder Deinstallationen} zu vereinfachen. Vergessen Sie nie, daß `PROGDIR:' das ist, was Sie vielleicht wirklich wollen.
  
  
• Wenn Sie die benötigten Dateien nicht beisammenhalten können, versuchen Sie zumindest, etwas anderes als z.B. `LIBS:' als Ziel zu wählen. {Der Idealfall wäre wahrscheinlich, den User vor der Installation wählen zu lassen, ob die Dateien in ein Verzeichnis oder in die System-Verzeichnisse installiert werden sollen. Hierzu ist es natürlich auch nötig, daß die zu installierende Anwendung systemkonform gestaltet wurde.}
  
  
• Bieten Sie immer immer eine Deinstallation in Ihren Scripts an. Dies ist ein weiterer Grund, weshalb die Dateien nicht so sehr über das System verteilt werden sollten. {Dies ist freilich korrekt. Letztendlich hat aber alles Vor- und Nachteile. Wird immer alles in Extra-Verzeichnisse installiert, hat der User am Ende diverse Libraries vielleicht hundertmal auf der Platte. Ganz abgesehen von dieser Kapazitätsverschwendung wäre ein Update der Library selbst ein sehr umständliches Unterfangen. Ich denke, hier sollte jeder selbst entscheiden, was er für die Installation seiner Applikation für das sinnvollste hält.}
  
  
• Wenn Sie Libraries installieren oder entfernen, achten Sie darauf, daß Sie nicht einfach existierende Libraries überschreiben oder löschen, die von anderen Programmen benötigt werden könnten. Wenn Sie sich nicht sicher sind, fragen Sie den User, sofern dieser nicht den NOVICE-Modus gewählt hat. {Was das Überschreiben von bereits installierten System-Dateien betrifft, so bietet der Installer mit der (COPYLIB )-Funktion eine sehr schöne Lösung, die dem Script- Schreiber viel Aufwand abnimmt. Das Löschen von Libraries aus `LIBS:' würde ich persönlich ganz vermeiden, da auch ein Experte nicht den kompletten Überblick haben kann, welches Programm welche Library benutzt. Auf jeden Fall sollte ein NOVICE-User tatsächlich nicht mit einer solchen Frage belastet werden. Hier hilft nur noch, die Library einfach zu lassen, wo sie ist.}
  
  
• Lassen Sie den User nicht unnötig warten. Wenn Ihre Applikation auf eine Diskette paßt, stellen Sie ihm alle nötigen Fragen zu Beginn der Installation und beginnen Sie erst danach mit der eigentlichen Installation. {Da heutzutage ja kaum noch von Diskette installiert wird, ist anzuraten, dies immer so zu handhaben. Einige Funktionen erfordern allerdings eine Rückfrage an den User, so daß oben genannte Verfahrensweise nicht möglich ist. Hier empfiehlt sich, sofern machbar, diese Funktionen ganz am Ende des Scripts aufzurufen und den User über die vermutlich benötigte Installationszeit zu informieren, damit er nicht die ganze Zeit gebannt das Installer-Fenster ansehen muß.}
  
  
• Wenn Sie den User nach einem Verzeichnis für die Applikation fragen, stellen Sie klar, ob Sie dann noch selbst ein Verzeichnis anlegen oder ob der User es selbst erstellen muß. Dies war in der Vergangenheit die Quelle einiger Verwirrungen in vielen Scripts. {Sofern möglich, empfiehlt es sich, immer ein Unterverzeichnis für seine Anwendung zu kreieren, da dann einfach mehr Ordnung herrscht. Perfektionisten fragen einfach den User, wie er's gern hätte - aber nicht den NOVICE-User!}
  
  
• Stellen Sie keine Fragen, wenn der User den NOVICE-Modus gewählt hat. Sollte es sich nicht vermeiden lassen, unterstützen Sie den NOVICE-Modus nicht. Jedwede Installation im NOVICE-Modus sollte fähig sein, komplett ohne Interaktion mit dem User erfolgreich abgeschlossen zu werden.
  
  
• Unterscheiden Sie zwischen AVERAGE- und EXPERT-Modus. {Der Installer behandelt diese beiden gleich.} Im EXPERT-Modus sollte der User zu einfach allem seinen Senf dazugeben können. Im AVERAGE-Modus sollten nur die wesentlichsten Fragen gestellt werden. Lassen Sie EXPERT- und AVERAGE-Modus nicht gleich werden. Geben Sie einem User, der sich als Experte einschätzt etwas, womit er sich beschäftigen kann, und verwirren Sie einen durchschnittlichen User nicht zu sehr. {Auch wenn man dazu neigt, die User-Modus-Verwaltung für seine eigenen Bedürfnisse zu definieren, so sollte man sich an diese Richtlinien halten, denn ein User, der viele Scripts benutzt hat, in denen es keinen Unterschied zwischen AVERAGE und EXPERT gab, gelangt auf Dauer zu der Überzeugung, daß dies keinen Unterschied macht. Seien Sie auch vorsichtig mit dem, was Sie im NOVICE-Modus anrichten. "Vergewaltigen" Sie den User hier nicht, sonst wird er nie wieder einen NOVICE-Modus wählen.}